docs: consolidate overview page #574
Conversation
remove bold add italics update links
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #574 +/- ##
=======================================
Coverage 76.01% 76.01%
=======================================
Files 42 42
Lines 2468 2468
=======================================
Hits 1876 1876
Misses 592 592
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| @@ -0,0 +1,155 @@ | |||
| --- | |||
There was a problem hiding this comment.
Same issue. Can the overview page be brought one level up? Overview page under an overview section is kinda weird UX
|
|
||
| Key features: | ||
|
|
||
| - Synchronous and asynchronous interfaces for flexible integration |
There was a problem hiding this comment.
MInor: For integration of what, where? I'd consider specifying.
| ```sh | ||
| pip --version | ||
| ``` | ||
|
|
||
| If these commands return the respective versions, you're ready to continue. |
There was a problem hiding this comment.
Do you actually need to check the version of pip, or do you only need to check that it's correctly configured?
There was a problem hiding this comment.
I think in this case it's just to be more explicit. since you need a package manager we want users to check that they actually have it.
There was a problem hiding this comment.
It is written one block above; it is for the verification that Python and pip are installed.
|
|
||
| ## Authentication and initialization | ||
|
|
||
| To use the client, you need an [API token](/platform/integrations/api#api-token). You can find your token under the [Integrations](https://console.apify.com/account/integrations) tab in Apify Console. Copy the token and initialize the client by providing it as a parameter to the `ApifyClient` constructor. |
There was a problem hiding this comment.
Maybe add "Have an Apify account" to prereqs? It sounds basic, but you actually do need it :D
fix links in left side and top side navbars
Co-authored-by: Marcel Rebro <[email protected]>
|
|
||
| ::: | ||
|
|
||
| ## Quick start |
There was a problem hiding this comment.
Just note that we have these quick start sections in overview pages, but ideally over time it would be good to have stand alone quick start pages in all JS, Python Clients/SDKs, and have overview just a really quick overview of the tool
There was a problem hiding this comment.
but that defeats the purpose of what we did, does it not? We had separate quick start (and other pages) and we merge them into one overview, only to later, divide them again into overview and quick start?
There was a problem hiding this comment.
But it does not make sense imho, even after the discussion about our KR, where we specifically mentioned that we want to have each page designed for "one purpose".
Maybe we should have some discussion about the general structure of these documentation to prevent these misunderstandings. For example, in the CLI we have Overview, Installation, and Quick Start. I think this work very good as each page has clear purpose.
There was a problem hiding this comment.
No no, that makes sense to me in the long run. Do you want us to move quick start to separate page as part of this PR or separate issue and we can move forward how it is now?
There was a problem hiding this comment.
Nono, let's keep it as it is now. I do not want to block this we want to remove the landing pages. It was more "once we start to work on the redesign", probably in Q2 :D
No description provided.